/*
 * @Author: 0x9DEFA478
 * @Date: 2024-08-04 15:13:52
 * @LastEditTime: 2024-08-10 17:24:11
 * @LastEditors: 0x9DEFA478
 * @Description: 
 * QQ:2652450237
 * ============================================================================================================================================
 * 
 * 
 * 
 *                                                                                               ************      ****************************
 *                                                                                             ************      ****************************  
 *                                                                                           ************      ****************************    
 *                                                                                         ************      ****************************      
 *                                                                                       ************      ************                        
 *                                                                                     ************      ************                          
 *                                                                                   ************      ************                            
 *                                                                                 ************      ************                              
 *                                                                               ************      ************                                
 *                                                                             ************      ************                                  
 *                                                                           ************      ************                                    
 *                                                                         ************      ************                                      
 *                                                                       ************      ************                                        
 *                                                                     ************      ************                                          
 *                                                                   ************      ************                                            
 *                                                                 ************      ************                                              
 *                                                               ************      ************                                                
 *                                                             ************      ************                                                  
 *                                                           ************      ************                                                    
 *                                                         ************      ************                                                      
 *                                                       ************      ************                                                        
 *                                                     ************      ************                                                          
 *                                                   ************      ************                                                            
 *                                                 ************      ************                                                              
 *                                               ************      ************                                                                
 *                                             ************      ************                                                                  
 *                                           ************      ************                                                                    
 *                                         ************      ************                                                                      
 *                                       ************      ************                                                                        
 *                                     ************      ************                                                                          
 *                                   ************      ************                                                                            
 *                                 ************      ************                                                                              
 *                               ************      ************                                                                                
 *                             ************      ************                                                                                  
 *                           ************      ************                                                                                    
 *                         ************      ************                                                                                      
 *       ****************************      ************                                                                                        
 *     ****************************      ************                                                                                          
 *   ****************************      ************                                                                                            
 * ****************************      ************                                                                                              
 * 
 * 
 * 
 * ============================================================================================================================================
 * 
 */
#ifndef hAPI_H_TS_Queue_H_
#define hAPI_H_TS_Queue_H_
#include "./H_TS_Semaphore.h"




typedef struct{
  H_TS_Semaphore Semaphore;

  volatile Hsize ReadIndex;
  volatile Hsize WriteIndex;
  Hsize Size;
  void* volatile* Data;
}H_TS_Queue;




/**
 * @brief 构造一个队列
 * @param Semaphore 待构造的内存
 * @param Data 队列需要的缓冲区 大小(Size*sizeof(void*))
 * @param Size 队列容量 最小为2 最大只能容纳(Size-1)个项目
 * @return 无
 */
void H_TS_Queue_Init(H_TS_Queue* Queue,void** Data,Hsize Size);

/**
 * @brief 析构一个队列
 * @param Queue 待析构的队列
 * @return 目前实现只会返回0
 */
int H_TS_Queue_Deinit(H_TS_Queue* Queue);

/**
 * @brief 新建队列
 * @param Size 队列容量 最小为2 最大只能容纳(Size-1)个元素
 * @return 队列对象 如果为NULL 则失败
 */
H_TS_Queue* new_H_TS_Queue(Hsize Size);

/**
 * @brief 删除队列
 * @param Queue 待删除队列
 * @return 0:成功 -1:队列正在被其他线程占用
 */
int delete_H_H_TS_Queue(H_TS_Queue* Queue);

/**
 * @brief 向队列添加元素 由中断调用
 * @param Queue 待添加元素的队列
 * @param Item 不为NULL的待添加元素
 * @return 0:成功 其他:队列已满
 */
int H_TS_Queue_TryPush_ISR(H_TS_Queue* Queue,void* Item);

/**
 * @brief 向队列添加元素
 * @param Queue 待添加元素的队列
 * @param Item 不为NULL的待添加元素
 * @return 0:成功 其他:队列已满
 */
int H_TS_Queue_TryPush(H_TS_Queue* Queue,void* Item);

/**
 * @brief 向队列添加元素
 * @param Queue 待添加元素的队列
 * @param Item 不为NULL的待添加元素
 * @return 无
 */
void H_TS_Queue_Push(H_TS_Queue* Queue,void* Item);

/**
 * @brief 向队列添加元素 时间限制
 * @param Queue 待添加元素的队列
 * @param Item 不为NULL的待添加元素
 * @param Timeout 超时时间
 * @return 0:成功 其他:超时
 */
int H_TS_Queue_Push_Time(H_TS_Queue* Queue,void* Item,H_TS_Tick Timeout);

/**
 * @brief 尝试从队列弹出元素
 * @param Queue 待弹出元素的队列
 * @return 元素指针 如果为NULL则代表队列空
 */
void* H_TS_Queue_TryPop(H_TS_Queue* Queue);

/**
 * @brief 从队列弹出元素
 * @param Queue 待弹出元素的队列
 * @return 元素指针
 */
void* H_TS_Queue_Pop(H_TS_Queue* Queue);

/**
 * @brief 从队列弹出元素 时间限制
 * @param Queue 待弹出元素的队列
 * @param Timeout 超时时间
 * @return 元素指针 如果为NULL则代表超时
 */
void* H_TS_Queue_Pop_Time(H_TS_Queue* Queue,H_TS_Tick Timeout);




#endif //hAPI_H_TS_Queue_H_
